ARDK for Android/com.nianticlabs.ardk.scanning/ScanningSession
ScanningSession
[androidJvm]
class ScanningSession : SessionBase<ScanningSession>
A session for 3D scanning and visualization functionality.
The scanning feature capabilities for capturing, processing, and exporting 3D scan data from AR sessions. Scans of a location can be processed by the Visual Positioning System's (VPS's) cloud services to enable VPS localization.
Types
| Name | Summary |
|---|---|
| Companion | [androidJvm] object Companion |
Functions
| Name | Summary |
|---|---|
| acquire | [androidJvm] @Synchronized fun acquire(): ScanningSession |
| close | [androidJvm] @Synchronized open override fun close() |
| configure | [androidJvm] fun configure(config: ScannerConfig) Configure the session with the specified settings. |
| create | [androidJvm] @MainThread fun create() |
| exportScan | [androidJvm] fun exportScan(jsonMetadata: String?, exportAsVideo: Boolean = true): String? Exports the scan data as an archive file. |
| featureStatus | [androidJvm] fun featureStatus(): FeatureStatus Reports errors that have occurred with processes running inside this feature. |
| getRecordingInfo | [androidJvm] fun getRecordingInfo(): RecordingInfo |
| save | [androidJvm] suspend fun save(timeoutMillis: Long = TIMEOUT_MS): AsyncResult<ScanSaveInfo, ScanSaveError> Asynchronously saves the current scan and polls until the operation is complete. |
| start | [androidJvm] fun start() Start scanning. |
| stop | [androidJvm] fun stop() Stop all scanning processes. |